home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / language / embedded / develop / ad2mac.arc / AD2MAC.DOC < prev    next >
Text File  |  1989-08-04  |  6KB  |  146 lines
  1. AD2MAC.DOC                                                      04 AUG. 1989
  2.  
  3. Generate symbol table macro file from 2500AD listing file
  4. =========================================================
  5.   By Fai Lee Tung Steinberg, Motorola Development Systems, Austin, Texas
  6.  
  7.  
  8. 1. PURPOSE
  9.  
  10.     AD2MAC extracts the symbols/values from the assembly language listing
  11.     file produced by the 2500AD assembler and creates a macro file that the
  12.     Motorola HDS-300 Hardware Development Station can use to obtain the
  13.     symbol information for Symbolic Debug support.  An option converts the
  14.     output format for use with the Motorola CSIC Development System (CDS)
  15.     for Symbolic Debug support there also.
  16.  
  17.  
  18. 2. INSTALLATION
  19.  
  20.     a. Files:
  21.  
  22.         Mandatory:
  23.  
  24.          1. AD2MAC.EXE ------ 2500AD to macro executable file.
  25.  
  26.          2. 2500AD Cross Assembler product.  The following 2500AD products
  27.             have been tested and verified as compatible with AD2MAC:
  28.  
  29.               Description/Version                        Asm Executable
  30.               ---------------------------------------    --------------
  31.               6805  Cross Assembler, Version 4.03a       X6805.EXE
  32.               68C11 Macro Assembler, Version 4.03a       X68C11.EXE
  33.  
  34.             Other 2500AD compatible assemblers may also work with little
  35.             or no modifications to the AD2MAC program, but they have not
  36.             been tested yet.  The assembler is not supplied with AD2MAC.
  37.             It must be purchased separately from...
  38.  
  39.                         2500AD Software Inc.       (719) 395-8683
  40.                         109 Brookdale Ave, Box 480
  41.                         Buena Vista, CO  81211
  42.  
  43.         Optional:
  44.  
  45.          1. AD2MAC.DOC ------ The information file you are reading now.
  46.          2. AD*.BAT    ------ Batch files to automate Symbolic Debug
  47.                               support.  Assembles and generates symbol
  48.                               macro file.  Currently supplied files are
  49.                               AD05.BAT and AD11.BAT for 6805 and 68HC11,
  50.                               respectively.  These files show how to run
  51.                               things and may be customized by the user.
  52.  
  53.     b. Hardware:
  54.         An IBM PC/AT/XT, or true compatible running MS-DOS, PC-DOS at least
  55.         version 3.20.
  56.  
  57.     c. Procedure:
  58.         Copy AD2MAC.EXE and the AD*.BAT files to your execution directory,
  59.         e.g. \bin or \exe.  Set the MS-DOS "path" command properly so the
  60.         operating system can locate them for execution.  The 2500AD assem-
  61.         bler should be installed per its documentation.  The other option-
  62.         al files can also be copied or just listed, as desired.
  63.  
  64.  
  65. 3. COMMAND SYNTAX/DESCRIPTION
  66.  
  67.     Syntax:
  68.  
  69.        AD2MAC <ad25name> [/i] [/c]
  70.  
  71.     Description:
  72.  
  73.        AD2MAC reads the specified file, extracts the symbol table infor-
  74.        mation (symbol and value), and creates a symbol file with the exten-
  75.        sion .MAC.  The symbol file is composed of lines of the format
  76.        "<cmd> <symbol> <value>".
  77.  
  78.        For HDS-300 support, <cmd> = " @LS", and the symbol file must be
  79.        downloaded to an HDS-300 and executed with the "macro file" (MF)
  80.        command.  This loads the symbols/values into the local symbol table
  81.        so HDS-300 Symbolic Debug can be accomplished.
  82.  
  83.        For CDS support, <cmd>= "DEFINE", and the symbol file must be load-
  84.        ed using the "command file" (CF) command.  This loads the symbols/
  85.        values into the local symbol table so CDS Symbolic Debug can be
  86.        accomplished.
  87.  
  88.     Where:
  89.       <ad25name>     is the name of an 2500AD assembler listing file.  A
  90.                      default extension of .LST is assumed.
  91.  
  92.       /i             is an option to ignore non-referenced, i.e. unused,
  93.                      symbols.  When this option is invoked, only referenced
  94.                      symbols will be processed into the output macro file.
  95.  
  96.       /c             is an option to set AD2MAC for CDS support.
  97.  
  98.     Examples:
  99.  
  100.        AD2MAC  myprog         Processes 2500AD listing file MYPROG.LST and
  101.                               creates MYPROG.MAC symbolic file in HDS-300
  102.                               output format.  All symbols are processed.
  103.  
  104.        AD2MAC  file2.lst /i   Processes 2500AD listing file FILE2.LST and
  105.                               creates FILE2.MAC symbolic file in HDS-300
  106.                               output format.  Non-referenced (unused)
  107.                               symbols are ignored (not processed).
  108.  
  109.        AD2MAC  john /c        Processes 2500AD listing file JOHN.LST and
  110.                               creates JOHN.MAC symbolic file in CDS output
  111.                               format.  All symbols are processed.
  112.  
  113.  
  114. 4. RESTRICTIONS
  115.  
  116.     a. Because the symbol file will be used on a CDS or HDS-300 system, it
  117.        must follow the symbol rules for that system.  Thus AD2MAC operates
  118.        under the following rules:
  119.           1. All symbol names are truncated to the appropriate size for the
  120.              intended system (CDS= 31 characters, HDS-300= 8 characters).
  121.              It is up to the user to ensure symbol names are unique within
  122.              this truncated size.  Symbols are case sensitive on the CDS
  123.              system ("start" not= "START"), but insensitive on the HDS-300
  124.              ("start" = "START").
  125.           2. The following characters are valid for symbol names: letters,
  126.              numbers, period (.), underscore (_), and dollar sign ($)
  127.           3. Symbol names must begin with a letter, period, or underscore.
  128.           4. Invalid symbol name characters found in the input file will be
  129.              replaced by underscore characters.
  130.           5. Symbol names like ".25" should be avoided because of possible
  131.              parsing confusion (is ".25" a symbol name or a real number?).
  132.  
  133.     b. Multiple modules, i.e. relocatable (relative) assemblies, are not
  134.        supported in this version.  This version was intended to only
  135.        support single module, absolute assemblies.
  136.  
  137.  
  138. 5. BUG FIXED
  139.     a. None.
  140.  
  141.  
  142. 6. KNOWN BUGS
  143.     a. None.
  144.  
  145. *** EOF ***
  146.